| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

Function.h
1 // Function.h
3 //
5
6 namespace nkScripts
7 {
49 class Function
50 {
51 public :
52
53 // Attributes
54 OutputValue defaultFunction (const DataStack& stack) ;
55
56 public :
57
63 Function (nkMemory::StringView name) noexcept ;
67 virtual ~Function () ;
68
69 // Getters
73 nkMemory::StringView getName () const ;
74
75 // Parameters
94 void addParameter (FUNCTION_PARAMETER_TYPE type, nkMemory::StringView userTypeName = "") ;
95
96 // Function
102 void setFunction (FunctionCallback function) ;
103
107 void reset () ;
108 } ;
109 }
nkScripts
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
nkMemory::BufferView
A view over data.
Definition: BufferView.h:18
nkScripts::Function::defaultFunction
OutputValue defaultFunction(const DataStack &stack)
The default place holder function. Set by default.
nkScripts::Function::~Function
virtual ~Function()
nkScripts::Function::setFunction
void setFunction(FunctionCallback function)
nkScripts::FunctionParameter
A function parameter, used within the stack of arguments.
Definition: FunctionParameter.h:25
nkScripts::Function::addParameter
void addParameter(FUNCTION_PARAMETER_TYPE type, nkMemory::StringView userTypeName="")
nkScripts::FunctionCallback
std::function< OutputValue(const DataStack &)> FunctionCallback
A callback in C++, the script environment will call when tied.
Definition: FunctionDefines.h:10
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkScripts::Function::Function
Function(nkMemory::StringView name) noexcept
nkScripts::Function::reset
void reset()
nkScripts::FUNCTION_PARAMETER_TYPE
FUNCTION_PARAMETER_TYPE
Describes a variable type.
Definition: FunctionParameterType.h:12
nkScripts::Function
Holds information, and controls, over a function in a scripting environment.
Definition: Function.h:50
nkScripts::Function::getName
nkMemory::StringView getName() const